Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Terraform Documentation for k8s, k8s-worker charms #920

Merged
merged 3 commits into from
Dec 20, 2024
Merged

Add Terraform Documentation for k8s, k8s-worker charms #920

merged 3 commits into from
Dec 20, 2024

Conversation

louiseschmidtgen
Copy link
Contributor

@louiseschmidtgen louiseschmidtgen commented Dec 19, 2024 •
edited
Loading

Add Terraform docs for k8s, k8s-worker charms

This PR adds documentation on the k8s and k8s-worker terraform modules.

@louiseschmidtgen louiseschmidtgen requested a review from a team as a code owner December 19, 2024 10:25
@louiseschmidtgen louiseschmidtgen changed the title Add terraform docs for k8s, k8s-worker charms Add Terraform docs for k8s, k8s-worker charms Dec 19, 2024
@louiseschmidtgen louiseschmidtgen changed the title Add Terraform docs for k8s, k8s-worker charms Add Terraform Documentation for k8s, k8s-worker charms Dec 19, 2024
nhennigan
nhennigan reviewed Dec 19, 2024
View reviewed changes
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small nits to help improve the flow but overall great work 😺

docs/src/charm/howto/install-terraform.md
| - | - | - | - | - |
| `app_name`| string | Application name | False | k8s |
| `base` | string | Ubuntu base to deploy the charm onto | False | [email protected] |
| `channel`| string | Channel that the charm is deployed from | False | 1.30/edge |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be 1.30/edge?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't catch this in the k8s-operator PR, so I'll bump it with the next terraform work (openstack) and its complementary documentation.

docs/src/charm/howto/install-terraform.md Outdated Show resolved Hide resolved
docs/src/charm/howto/install-terraform.md Outdated Show resolved Hide resolved
docs/src/charm/howto/install-terraform.md Outdated Show resolved Hide resolved
docs/src/charm/howto/install-terraform.md Outdated Show resolved Hide resolved
docs/src/charm/howto/install-terraform.md Outdated Show resolved Hide resolved
docs/src/charm/howto/install-terraform.md Outdated Show resolved Hide resolved
nhennigan
nhennigan approved these changes Dec 20, 2024
View reviewed changes
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for applying those changes. 😃

@louiseschmidtgen louiseschmidtgen merged commit c968e6d into main Dec 20, 2024
6 checks passed
@louiseschmidtgen louiseschmidtgen deleted the KU-2245/terraform-get-started branch December 20, 2024 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhennigan nhennigan nhennigan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@louiseschmidtgen @nhennigan